Templates

There is a lot to cover here but for now we will cover the basics.

Branches most fundamentally define Templates - either an Agent Template or a Scenario Template. These Templates then define reusable, instantiatable definitions for an Agent or Scenario. To recap, an Agent is an actor within a simulation and a Scenario defines the simulation (including the Agents that make it up and the Templates that define them). Therefore, Agent Templates capture the model for a system while Scenario Templates capture the instantiation of differentiated Agents, the resolution of their abstract "Targets", and the configuration of the simulation clock.

A Template is made up of Blocks - each existing within a Block Group inside of the Template. A Block Group is much like a traditional database table but with more flexibility. The following is the default Scenario Template:

{
    'ClockConfig': {}, # Block Group
    'TemplateRef': {}, # Block Group
    'Agent': {}, # Block Group
    'clockConfig': None, # root property (in this case a relation to a ClockConfig Block)
    'agents': [], # root property (in this case a relation to a set of Agent Blocks)
}

Templates are modified by creating, updating, and deleted their Blocks using the "Blocks" endpoints below.

Template Composition

Scenario Template

• Agent
• TemplateRef
• ClockConfig

Agent Template

All Blocks not referenced above under "Scenario Template"

Queries

Data is queried via 4 URL query parameters:

• id: The ID of the data set to query. This ID can be retrieved from the Simulation Job.
• start: The start time of the window in MJD
• stop: The stop time of the window in MJD
• binWidth: (optional) The bin width to use to down-sample the data. If omitted, data will be full resolution.

Example request: GET: /data/?id=<id>&start=<start>&stop=<stop>&binWidth=<binWidth>

Response

Data is returned from a query in the following format:

{
    "meta": {}, // TODO
    "series": { 
        <streamId>: [
            [<timestamp1::MJD>, <timestamp2::MJD>, ...],
            {
                <agentId>: {
                    <blockId>: {
                        <stateVariableA>: [<valueA1>, <valueA2>, ...],
                        <stateVariableB>: [<valuB1>, <valueB2>, ...],
                        ...
                    },
                    <stateVariableC>: [<valueC1>, <valueC2>, ...]
                },
                ...
            }
        ],
        ...
    }
}